Crate ockam_core
source · [−]Expand description
Core types of the Ockam library.
This crate contains the core types of the Ockam library and is intended for use by other crates that provide features and add-ons to the main Ockam library.
The main Ockam crate re-exports types defined in this crate.
Re-exports
pub extern crate async_trait;pub use traits::*;Modules
A facade around the various collections and primitives needed to
support std, no_std + alloc or no_std targets.
The traits module provides extended implementations of standard traits.
Core types and traits of the Ockam vault.
Macros
Structs
A generic address type.
An error which is returned when address parsing from string fails.
A read-only set containing a Vec of Address structures.
An Access Control type that allows all messages to pass through.
A passthrough marker message type.
An Access Control type that blocks all messages from passing through.
The type of errors returned by Ockam functions.
Contains metadata that will only be routed locally within the local Ockam Node.
A message type that is routed locally within a single node.
A user-defined protocol identifier.
A full route to a peer.
A utility type for building and manipulating routes.
A message wrapper that provides message route information.
A generic transport message type.
The transport type of an address.
Unsigned integer implementation that supports serde_bare
serialization as a 64 bit uint type.
Enums
Enum to store the cause of an address parsing failure.
A routing specific error type.
Constants
The local transport type.
Traits
Defines the interface for message flow authorization.
Decode a slice.
A user defined message that can be serialised and deserialized.
Defines an interface for Ockam Workers that need to continuously perform background operations.
Defines the core interface shared by all Ockam Workers.
Functions
Produces Ok(true) to avoid an ambiguous reading from using the unadorned value in auth code.
Produces Ok(false) to avoid an ambiguous reading from using the unadorned value in auth code.
Type Definitions
Attribute Macros
Mark an Ockam Processor implementation.
Mark an Ockam Worker implementation.
Derive Macros
Custom derive for the ockam_core::AsyncTryClone trait.
Implements Message trait for a type.